SonarSource Rules
  • Products

    In-IDE

    Code Quality and Security in your IDE with SonarQube Ide

    IDE extension that lets you fix coding issues before they exist!

    Discover SonarQube for IDE

    SaaS

    Code Quality and Security in the cloud with SonarQube Cloud

    Setup is effortless and analysis is automatic for most languages

    Discover SonarQube Cloud

    Self-Hosted

    Code Quality and Security Self-Hosted with SonarQube Server

    Fast, accurate analysis; enterprise scalability

    Discover SonarQube Server
  • SecretsSecrets
  • ABAPABAP
  • AnsibleAnsible
  • ApexApex
  • AzureResourceManagerAzureResourceManager
  • CC
  • C#C#
  • C++C++
  • CloudFormationCloudFormation
  • COBOLCOBOL
  • CSSCSS
  • DartDart
  • DockerDocker
  • FlexFlex
  • GitHub ActionsGitHub Actions
  • GoGo
  • HTMLHTML
  • JavaJava
  • JavaScriptJavaScript
  • JSONJSON
  • JCLJCL
  • KotlinKotlin
  • KubernetesKubernetes
  • Objective CObjective C
  • PHPPHP
  • PL/IPL/I
  • PL/SQLPL/SQL
  • PythonPython
  • RPGRPG
  • RubyRuby
  • RustRust
  • ScalaScala
  • ShellShell
  • SwiftSwift
  • TerraformTerraform
  • TextText
  • TypeScriptTypeScript
  • T-SQLT-SQL
  • VB.NETVB.NET
  • VB6VB6
  • XMLXML
  • YAMLYAML
Ruby

Ruby static code analysis

Unique rules to find Bugs, Security Hotspots, and Code Smells in your RUBY code

  • All rules 42
  • Bug7
  • Security Hotspot2
  • Code Smell33
 
Tags
    Impact
      Clean code attribute
        1. Multi-line comments should not be empty

           Code Smell
        2. Methods should not have identical implementations

           Code Smell
        3. Cognitive Complexity of functions should not be too high

           Code Smell
        4. Ruby parser failure

           Code Smell
        5. Boolean checks should not be inverted

           Code Smell
        6. Two branches in a conditional structure should not have exactly the same implementation

           Code Smell
        7. "case" statements should not be nested

           Code Smell
        8. Unused local variables should be removed

           Code Smell
        9. "case" statements should not have too many "when" clauses

           Code Smell
        10. Track lack of copyright and license headers

           Code Smell
        11. Functions should not have too many lines of code

           Code Smell
        12. Control flow statements "if", "for", "while", "until", "case" and "begin...rescue" should not be nested too deeply

           Code Smell
        13. Octal values should not be used

           Code Smell
        14. "case" statements should have "else" clauses

           Code Smell
        15. "if ... else if" constructs should end with "else" clauses

           Code Smell
        16. Statements should be on separate lines

           Code Smell
        17. String literals should not be duplicated

           Code Smell
        18. Methods should not be empty

           Code Smell
        19. Unused function parameters should be removed

           Code Smell
        20. Function and block parameter names should comply with a naming convention

           Code Smell
        21. "case when" clauses should not have too many lines of code

           Code Smell
        22. Track uses of "TODO" tags

           Code Smell
        23. Track uses of "FIXME" tags

           Code Smell
        24. Redundant pairs of parentheses should be removed

           Code Smell
        25. Nested blocks of code should not be left empty

           Code Smell
        26. Functions should not have too many parameters

           Code Smell
        27. Expressions should not be too complex

           Code Smell
        28. Mergeable "if" statements should be combined

           Code Smell
        29. Tabulation characters should not be used

           Code Smell
        30. Files should not have too many lines of code

           Code Smell
        31. Lines should not be too long

           Code Smell
        32. Class names should comply with a naming convention

           Code Smell
        33. Method names should comply with a naming convention

           Code Smell

        Cognitive Complexity of functions should not be too high

        adaptability - focused
        maintainability
        Code Smell
        • architecture
        • brain-overload

        This rule raises an issue when the code cognitive complexity of a function is above a certain threshold.

        Why is this an issue?

        More Info

        Cognitive Complexity is a measure of how hard it is to understand the control flow of a unit of code. Code with high cognitive complexity is hard to read, understand, test, and modify.

        As a rule of thumb, high cognitive complexity is a sign that the code should be refactored into smaller, easier-to-manage pieces.

        Which syntax in code does impact cognitive complexity score?

        Here are the core concepts:

        • Cognitive complexity is incremented each time the code breaks the normal linear reading flow.
          This concerns, for example, loop structures, conditionals, catches, switches, jumps to labels, and conditions mixing multiple operators.
        • Each nesting level increases complexity.
          During code reading, the deeper you go through nested layers, the harder it becomes to keep the context in mind.
        • Method calls are free
          A well-picked method name is a summary of multiple lines of code. A reader can first explore a high-level view of what the code is performing then go deeper and deeper by looking at called functions content.
          Note: This does not apply to recursive calls, those will increment cognitive score.

        The method of computation is fully detailed in the pdf linked in the resources.

        What is the potential impact?

        Developers spend more time reading and understanding code than writing it. High cognitive complexity slows down changes and increases the cost of maintenance.

          Available In:
        • SonarQube IdeCatch issues on the fly,
          in your IDE
        • SonarQube CloudDetect issues in your GitHub, Azure DevOps Services, Bitbucket Cloud, GitLab repositories
        • SonarQube Community BuildAnalyze code in your
          on-premise CI
          Available Since
          9.1
        • SonarQube ServerAnalyze code in your
          on-premise CI
          Developer Edition
          Available Since
          9.1

        © 2008-2025 SonarSource SA. All rights reserved.

        Privacy Policy | Cookie Policy | Terms of Use